Creating and Searching for Specification Texts

Specification texts describe a certain aspect of a model element in the respective text definition (specification text).

Essential Specification Text Properties

A specification text describes certain aspects of a model element. The text definition controls which these will be respectively. Text definitions can be configured as components of the documentation.

Specification texts are possible for all model elements.
Specifications belong directly to the model element.
Text definitions can be configured per model element, e.g.
- Description
- Open issues
The text can be formatted, tables can be e.g. copied from Word
The text can contain links
- Model references (using drag-and-drop)
- Hyperlinks to external targets

Creating Specification Texts

Context

You can store any number of descriptions for each model element, show them in the respective model element's specification preview and connect them in their model's documentation later. These textual specifications are essential when creating a comprehensive model documentation. These texts are normally constantly maintained throughout the course of the project.

Text is inputted for element descriptions directly in the respective document window. You can use drag-and-drop to insert references on model elements; these are then maintained when renaming the element.

You can also use text files which were produced in other editors or in text processing programs as a copy source. Formatting is taken from Word.

You can customize the default format (font and size) for specification texts in the Specification Text Options section in the Display tab in the Options dialog (Application Menu>Options ([Alt]+[MI]).

Configured text definitions always exist and cannot be deleted for individual model elements. They can only be empty.

How to proceed

Select the model element you want to describe.
Select Design>Model Elements>Specification Text (F3).

The model element's specification window appears.
Select the text element which contains the text you want to edit.
Enter the text according to the selected text definition.

The name of the text definition to be edited is shown in red if your changes have been made.
Drag a selected model element and drop it on the desired position in the specification text to insert a reference as a hyperlink on the element.
Format the text using the Text tab or the context menu.
Save the specification with Text>Editing>Save (Ctrl+S).

The name of the edited text is shown as black.

Searching in Specification Texts

Context

You can search for text in text definitions.

How to proceed

Select Start>Browse>Find>Find in Specifications (Ctrl+F3).
Enter the text or text pattern in the Contained Text field. Regular expressions are supported for this.
Select the element type which you want to limit the search to from the Find Element Type drop-down list.
Select the text definition which you want to limit the search to from the Find in Text Definition drop-down list.
Activate the corresponding search options if you want case sensitivity to be taken into consideration or if you should only search for whole words.
Click on Find.

The elements found are listed with the searched text in the result region.
If you want to save the current search with a name and description so you can reuse it, click on Save.

A dialog appears which you can add the information required in.